Do not use query components in URLs for assets in EPUB rendering #11766
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the EPUB builder is detected, do not add checksums in a query component to the URL of css and js assets. The XHTML in EPUBs does not allow the use of query components in relative URLs. The checksumming of assets, introduced in ae20669 unconditionally adds a query component for the checksum, which breaks rendering on many enduser devices (tested on e.g. Kindle Paperwhite 3, Kobo Aura H2O Edition 2). Fixes sphinx-doc#11598 Signed-off-by: David Runge <[email protected]>
Contributor
Author
|
Hmm, I don't think the test failures for py312 and py313 are related to my change, or can they? 🤔 |
Member
|
You could swap the order of the check for a small optimisation, so that the file is not needlessly hashed when using an epub builder. A |
Member
|
Please may you also add a test |
# Conflicts: # CHANGES.rst
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Do not use query components in URLs for assets in EPUB rendering
Feature or Bugfix
Purpose
If the EPUB builder is detected, do not add checksums in a query component to the URL of css and js assets.
Detail
The XHTML in EPUBs does not allow the use of query components in relative URLs.
The checksumming of assets, introduced in
ae20669 unconditionally adds a query component for the checksum, which breaks rendering on many enduser devices (tested on e.g. Kindle Paperwhite 3, Kobo Aura H2O Edition 2).
Relates
Fixes #11598